[Platform] Add support for Google vertex AI #297

junaidbinfarooq · 2025-08-10T20:48:29Z

Q	A
Bug fix?	no
New feature?	yes
Docs?	yes
Issues	#16 #272
License	MIT

Changes proposed:

The PR aims to add support for Google's Vertex AI
Support is added for text generation, embeddings, server tools, etc
I created a separate directory inside the Bridge directory for the said bridge. Moving forward, we could either create a new namespace named Google and add two namespaces inside it, one each for Gemini and VertexAi, or we could simply keep VertexAi and remove the other, as this api already supports Gemini and more. Either way, Normalize Gemini vs Google #146 would be addressed.
I exempted the use of api key from the implementation so far as VertexAi supports two auth mechanisms, Api keys and ADC, ie, Application Default Credentials. The former is recommended for testing while the latter is recommended for production, IIRC. However, it does need to install gCloud on the server and locally too (if verifying the behavior without an api key). The Google auth library is also needed for automatic credential discovery.
More information can be found at https://cloud.google.com/vertex-ai/generative-ai/docs

chr-hertel · 2025-08-11T21:57:16Z

src/platform/composer.json

@@ -22,6 +22,7 @@
    "require": {
        "php": ">=8.2",
        "ext-fileinfo": "*",
+        "google/auth": "^1.47",


Please move it to require-dev and add a check for the class existence to the implementation, like in the Bedrock one for example:

ai/src/platform/src/Bridge/Bedrock/PlatformFactory.php

Lines 37 to 39 in 11ef98f

if (!class_exists(BedrockRuntimeClient::class)) {

throw new RuntimeException('For using the Bedrock platform, the async-aws/bedrock-runtime package is required. Try running "composer require async-aws/bedrock-runtime".');

}

aszenz · 2025-08-12T07:57:27Z

src/platform/src/Bridge/VertexAi/PlatformFactory.php

+        ?Contract $contract = null,
+    ): Platform {
+        if (!class_exists(ApplicationDefaultCredentials::class)) {
+            throw new RuntimeException('For using the Bedrock platform, the google/auth package is required. Try running "composer require google/auth".');


Suggested change

throw new RuntimeException('For using the Bedrock platform, the google/auth package is required. Try running "composer require google/auth".');

throw new RuntimeException('For using the Vertex AI platform, google/auth package is required for authentication via application default credentials. Try running "composer require google/auth".');

I did it already.
Pushing the change in a few moments.

faizanakram99

lgtm, ship it

junaidbinfarooq · 2025-08-12T09:13:44Z

lgtm, ship it

Docs and AI bundle integration need to be added first.

junaidbinfarooq · 2025-08-12T13:52:42Z

@chr-hertel
The PR is ready for review. Please review the changes and let me know your thoughts.
Thanks.

- Adds initial support to integrate text generation using vertex AI

- Adds support for embeddings

- Adds tests to verify the behavior

- Adds examples to interact with vertex ai

- Adds ai bundle integration

- Adds documentation for vertex ai

OskarStark · 2025-08-13T07:52:17Z

src/platform/src/Bridge/VertexAi/Contract/AssistantMessageNormalizer.php

+     *      }
+     *     }


The indention looks wrong

In the PHP doc, the IDE doesn't apparently help with the indentation in this case.
I tried to correct the indentation now.

chr-hertel · 2025-08-13T08:49:56Z

examples/vertexai/bootstrap.php

+ * file that was distributed with this source code.
+ */
+
+use Google\Auth\ApplicationDefaultCredentials;


this needs a new require in the examples/composer.json file - cannot run the examples locally at this point, sorry

Not a biggie.
I did think about it, but somehow it skipped my mind, probably because the examples worked for me as I included the autoload file in another way.

chr-hertel · 2025-08-13T08:52:29Z

src/ai-bundle/doc/index.rst

@@ -52,6 +52,9 @@ Configuration
                    api_version: '%env(AZURE_GPT_VERSION)%'
            gemini:
                api_key: '%env(GEMINI_API_KEY)%'
+            vertexAi:


would be

Suggested change

vertexAi:

vertex_ai:

Wouldn't it require a change inside AiBundle.php too? While integrating the bridge into the AI bundle, I looked for other bridges that had multiple words in them and found that they were added as a single word. And I followed suit.
I did, however, change it to vertexai.
Given your input on it, however, I'd be happy to change it to vertex_ai.

chr-hertel · 2025-08-13T08:55:26Z

src/platform/doc/vertexai-server-tools.rst

Instead of a similar doc to the gemini one, please combine the two files a la Server Tools - supported by VertexAI and Gemini API or sth

I did this on purpose so that when we later make a decision about whether we need both the bridges or only Vertex AI, then we could make such a refactor.

chr-hertel · 2025-08-13T08:56:10Z

src/ai-bundle/doc/index.rst

@@ -34,7 +34,7 @@ Configuration
                    class: 'Symfony\AI\Platform\Bridge\OpenAi\Gpt'
                    name: !php/const Symfony\AI\Platform\Bridge\OpenAi\Gpt::GPT_4O_MINI

-**Advanced Example with Anthropic, Azure, Gemini and multiple agents**
+**Advanced Example with Anthropic, Azure, Gemini, VertexAi and multiple agents**


the official product name is "Vertex AI" i guess

Suggested change

**Advanced Example with Anthropic, Azure, Gemini, VertexAi and multiple agents**

**Advanced Example with Anthropic, Azure, Gemini, Vertex AI and multiple agents**

chr-hertel · 2025-08-13T08:57:08Z

src/platform/doc/index.rst

@@ -73,13 +73,15 @@ usually defined by the specific models and their documentation.
    * `OpenAI's GPT`_ with `OpenAI`_ and `Azure`_ as Platform
    * `Anthropic's Claude`_ with `Anthropic`_ and `AWS Bedrock`_ as Platform
    * `Meta's Llama`_ with `Azure`_, `Ollama`_, `Replicate`_ and `AWS Bedrock`_ as Platform
-    * `Gemini`_ with `Google`_ and `OpenRouter`_ as Platform
+    * `Gemini`_ with `Google`_, `VertexAi`_ and `OpenRouter`_ as Platform


Suggested change

* `Gemini`_ with `Google`_, `VertexAi`_ and `OpenRouter`_ as Platform

* `Gemini`_ with `Google`_, `Vertex AI`_ and `OpenRouter`_ as Platform

chr-hertel · 2025-08-13T09:00:14Z

Thanks @junaidbinfarooq for your work on this - I think we're getting somewhere.
Please see my comments and review once again yourself with those in mind - not sure I catched everything.

In general it great to have that bridge, I still wonder tho about the amount of duplicated code with the Gemini bridge and we would need to support API Keys as well ... but both topics are fine as follow up

junaidbinfarooq · 2025-08-13T09:25:54Z

Thanks @junaidbinfarooq for your work on this - I think we're getting somewhere. Please see my comments and review once again yourself with those in mind - not sure I catched everything.

In general it great to have that bridge, I still wonder tho about the amount of duplicated code with the Gemini bridge and we would need to support API Keys as well ... but both topics are fine as follow up

@chr-hertel
You're welcome 😄
The duplication is expected as I did not touch the existing Gemini bridge code.
This is what I also pointed out in the PR description about possibly having Vertex AI only as we move forward.
If this is done, there would be no duplication anywhere as far as Google bridges are concerned.
And yes, I do believe this is better done in a follow-up PR after a proper discussion on the topic.

- Adds support to calculate the token usage

junaidbinfarooq changed the title ~~feat(platform): Add support for Google vertex AI~~ [Platform] Add support for Google vertex AI Aug 11, 2025

junaidbinfarooq marked this pull request as ready for review August 11, 2025 14:37

junaidbinfarooq requested review from chr-hertel, Nyholm and OskarStark as code owners August 11, 2025 14:37

carsonbot added Feature New feature Platform Issues & PRs about the AI Platform component Status: Needs Review labels Aug 11, 2025

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch 2 times, most recently from 14ae923 to 35d9a8b Compare August 11, 2025 21:53

chr-hertel reviewed Aug 11, 2025

View reviewed changes

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch from 35d9a8b to 9124195 Compare August 12, 2025 07:52

aszenz reviewed Aug 12, 2025

View reviewed changes

faizanakram99 approved these changes Aug 12, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Aug 12, 2025

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch from 9124195 to cd83b3b Compare August 12, 2025 09:13

junaidbinfarooq requested a review from chr-hertel August 12, 2025 13:29

carsonbot added Status: Needs Review and removed Status: Reviewed labels Aug 12, 2025

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch from 0cf0db1 to 1346440 Compare August 12, 2025 13:39

junaidbinfarooq added 6 commits August 13, 2025 10:43

feat(platform): Add support for Google vertex AI

b7095e1

- Adds initial support to integrate text generation using vertex AI

feat(platform): Add support for Google vertex AI

d5eab19

- Adds support for embeddings

feat(platform): Add support for Google vertex AI

41d4bf5

- Adds tests to verify the behavior

docs(platform): Add support for Google vertex AI

a8662f3

- Adds examples to interact with vertex ai

feat(platform): Add support for Google vertex AI

ea21289

- Adds ai bundle integration

docs(platform): Add support for Google vertex AI

6d8e535

- Adds documentation for vertex ai

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch from 1346440 to b08d7e7 Compare August 13, 2025 05:16

OskarStark reviewed Aug 13, 2025

View reviewed changes

chr-hertel requested changes Aug 13, 2025

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Aug 13, 2025

chr-hertel reviewed Aug 13, 2025

View reviewed changes

feat(platform): Add support for Google vertex AI

605bf5e

- Adds support to calculate the token usage

junaidbinfarooq force-pushed the feat/platform-support-for-vertex-ai branch from b08d7e7 to 605bf5e Compare August 13, 2025 09:34

carsonbot added Status: Needs Review and removed Status: Needs Work labels Aug 13, 2025

junaidbinfarooq requested review from OskarStark and chr-hertel August 13, 2025 09:37

	if (!class_exists(BedrockRuntimeClient::class)) {
	throw new RuntimeException('For using the Bedrock platform, the async-aws/bedrock-runtime package is required. Try running "composer require async-aws/bedrock-runtime".');
	}

	Advanced Example with Anthropic, Azure, Gemini, VertexAi and multiple agents
	Advanced Example with Anthropic, Azure, Gemini, Vertex AI and multiple agents

	* `Gemini`_ with `Google`_, `VertexAi`_ and `OpenRouter`_ as Platform
	* `Gemini`_ with `Google`_, `Vertex AI`_ and `OpenRouter`_ as Platform

Uh oh!

[Platform] Add support for Google vertex AI #297

Are you sure you want to change the base?

[Platform] Add support for Google vertex AI #297

Uh oh!

Conversation

junaidbinfarooq commented Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

faizanakram99 left a comment

Choose a reason for hiding this comment

Uh oh!

junaidbinfarooq commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

junaidbinfarooq commented Aug 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chr-hertel Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junaidbinfarooq Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chr-hertel commented Aug 13, 2025

Uh oh!

junaidbinfarooq commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

junaidbinfarooq commented Aug 10, 2025 •

edited

Loading

junaidbinfarooq commented Aug 12, 2025 •

edited

Loading

chr-hertel Aug 13, 2025 •

edited

Loading

junaidbinfarooq Aug 13, 2025 •

edited

Loading

junaidbinfarooq commented Aug 13, 2025 •

edited

Loading